Hybris Sales UX API icon

Hybris Sales UX API

1.0.x
(0 reviews)

resource -TMF-639 POST

This use case is to reserve the available MSISDN at Nokia

URL
https://[localhost]:[port]/ecom-sales-ux/v1/{businessId}/resource
url Param
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit.
Expected one is "PR"-Puerto Rico		Y
namevaluedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.		Y
Request
curl --location 'https://nonprod.esb.cloud.lla.com/test/ecom-sales-ux/ecom-sales-ux/v1/PR/resource' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92cCC' \
--header 'client_id: 784c9a6dd7ae49768816cab57fcf1fa1' \
--header 'client_secret: 187b259EB77441babbF611d2646C670d' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "MSISDN",
    "@type": "ReserveMSISDN",
    "resourceCharacteristic": [
        {
            "name": "OrderNo",
            "value": "APP-01234"
        },
        {
            "name": "ACTION",
            "value": "ReserveNumber"
        },
        {
            "name": "MSISDN",
            "value": ["17874999911","17874999912","17874999913","17874999914"],
            "valueType" : "array"
        },
        {
            "name": "UNLOCK_KEY",
            "value": "TXoAzh2iN6"
        },
        {
            "name": "ORDER_CUSTOMER_ID",
            "value": "ABC1234567890"
        }
    ]
}'
Request Definition
namevaluedescriptionrequired
namestringName of the entity resource request
Allowed values are: MSISDN		Y
@typestringType of the entity resource request
Allowed values are: ReserveMSISDN		Y
resourceCharacteristicarrayresource characteristic arrayY
resourceCharacteristic.namestringname of the resource characteristic
Allowed values are: OrderNo, ACTION, MSISDN, UNLOCK_KEY, ORDER_CUSTOMER_ID		Y
resourceCharacteristic.valuestringvalue of the resource characteristic
Example values are: APP-01234, ReserveNumber, ["17874999911","17874999912"], TXoAzh2iN6, ABC1234567890		Y
resourceCharacteristic.valueTypestringtype of the resource characteristic
Example values are: string, array		N
Response
{
    "resourceRelationship": [
        {
            "resource": {
                "id": "17874999911,reservation",
                "name": "MSISDN",
                "@type": "ReserveMSISDN",
                "resourceStatus": "reserved", //
                "description": "successfully reserved", //
                "resourceCharacteristic": [
                    {
                        "name": "MSISDN",
                        "value": "17874999911"
                    }
                ]
            }
        },
        {
            "resource": {
                "id": "17874999912,reservation",
                "name": "MSISDN",
                "@type": "ReserveMSISDN",
                "resourceStatus": "reserved", //
                "description": "successfully reserved", //
                "resourceCharacteristic": [
                    {
                        "name": "MSISDN",
                        "value": "17874999912"
                    }
                ]
            }
        },
        {
            "resource": {
                "id" : null,
                "resourceStatus": "alarm", //
                "description": "failed reservation reason", //
                "name": "MSISDN",
                "@type": "ReserveMSISDN",
                "resourceCharacteristic": [
                    {
                        "name": "MSISDN",
                        "value": "17874999913"
                    }
                ]
            }
        },
        {
            "resource": {
                "id" : null,
                "resourceStatus": "unknown", //
                "description": "unknown", //
                "name": "MSISDN",
                "@type": "ReserveMSISDN",
                "resourceCharacteristic": [
                    {
                        "name": "MSISDN",
                        "value": "17874999914"
                    }
                ]
            }
        }
    ]
}
Response Definition
namevaluedescriptionrequired
resourceRelationshiparrayresource relationship arrayN
resourceRelationship.resourceobjectresource objectN
resourceRelationship.resource.idstringunique identifier of the resource entity
Expected values: reservation reference ID from Nokia		N
resourceRelationship.resource.namestringname of the resource
Expected values: MSISDN		N
resourceRelationship.resource.@typestringtype of the resource
Expected values: ReserveMSISDN		N
resourceRelationship.resource.resourceStatusstringstatus of the resource entity
Expected values: reserved, alarm, unknown		N
resourceRelationship.resource.descriptionstringdescription of the resource entity
Expected values: successfully reserved		N
resourceRelationship.resource.resourceCharacteristicarrayresource characteristic arrayN
resourceRelationship.resource.resourceCharacteristic.namestringresource characteristic name
Expected values: MSISDN		N
resourceRelationship.resource.resourceCharacteristic.valuestringresource characteristic value
Expected values: 17874999914		N

Reviews